/*
 * Copyright (c) 2013   Tobias Welther
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package de.tudarmstadt.kom.androidsensorapi.sensor.data.concrete;

import android.hardware.Sensor;
import android.hardware.SensorEvent;

import java.util.Date;

import de.tudarmstadt.kom.androidsensorapi.sensor.data.AbstractSensorData;

/**
 * Created by Tobias Welther
 */
public class MagneticFieldSensorData extends AbstractSensorData{

    /**
     * The Strength of the Magnetic field in X direction
     */
    private final double fieldStrengthX;

    /**
    * The Strength of the Magnetic field in Y direction
    */
    private final double fieldStrengthY;

    /**
    * The Strength of the Magnetic field in Z direction
    */
    private final double fieldStrengthZ;


    /**
     * Creates a data set for an Orientation change.
     * It is flagged with an date and an the strength of the magnetic field in mT
     *
     * @param dateOfCreation the date of creation.
     * @param fieldStrengthX the magnetic field strength in micro Tesler
     * @param fieldStrengthY the magnetic field strength in micro Tesler
     * @param fieldStrengthZ the magnetic field strength in micro Tesler
     */
    public MagneticFieldSensorData(Date dateOfCreation, double fieldStrengthX,
                                   double fieldStrengthY, double fieldStrengthZ) {

        super(dateOfCreation);
        this.fieldStrengthX = fieldStrengthX;
        this.fieldStrengthY = fieldStrengthY;
        this.fieldStrengthZ = fieldStrengthZ;
    }


    /**
     * Generates Magnetic Field Data from a given SensorEvent.
     * It is assumed that the Event is of type: SensorInterface.TYPE_MAGNETIC_FIELD.
     *
     * This can throw an unsupported Operation Exception when the wrong or insufficient Data is passed.
     *
     * @param event to copy from
     *
     * @throws UnsupportedOperationException when wrong event is passed.
     */
    public MagneticFieldSensorData(SensorEvent event){
        super(event);

        if(event.sensor.getType() != Sensor.TYPE_MAGNETIC_FIELD ||
                event.values.length < 3){

            throw new UnsupportedOperationException("The Magnetic Field Data can not be read from: "
                    + event.sensor.getName());
        }

        float[] values = event.values;
        this.fieldStrengthX = values[0];
        this.fieldStrengthY = values[1];
        this.fieldStrengthZ = values[2];
    }


    /**
     * Returns the Field Strength in X direction.
     * Value is in micro Tesler
     *
     * @return magnetic field strength in X direction
     */
    public double getFieldStrengthX() {
        return fieldStrengthX;
    }

    /**
     * Returns the Field Strength in X direction.
     * Value is in micro Tesler
     *
     * @return magnetic field strength in X direction
     */
    public double getFieldStrengthY() {
        return fieldStrengthY;
    }

    /**
     * Returns the Field Strength in X direction.
     * Value is in micro Tesler
     *
     * @return magnetic field strength in X direction
     */
    public double getFieldStrengthZ() {
        return fieldStrengthZ;
    }

}
